<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>Docs For Class CodecDebug</title>
  <link rel="stylesheet" href="../media/stylesheet.css" />
  <script src="../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
  <script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
	var imgPlus = new Image();
	var imgMinus = new Image();
	imgPlus.src = "../media/images/plus.gif";
	imgMinus.src = "../media/images/minus.gif";
	
	function showNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgMinus.src;
		oTable.style.display = "block";
	}
	
	function hideNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgPlus.src;
		oTable.style.display = "none";
	}
	
	function nodeIsVisible(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
        		break;
        }
		return (oTable && oTable.style.display == "block");
	}
	
	function toggleNodeVisibility(Node){
		if (nodeIsVisible(Node)){
			hideNode(Node);
		}else{
			showNode(Node);
		}
	}
</script>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><!-- Start of Class Data -->
<h2>
	Class CodecDebug
</h2> (line <span class="linenumber">51</span>)
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
</script>

<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<pre>
</pre>
<p>
	<b><i>Located in File: <a href="_codecs---CodecDebug.php.html">/codecs/CodecDebug.php</a></i></b><br>
</p>
<!-- ========== Info from phpDoc block ========= -->
<h5>CodecDebug is a singleton class to aid Codec debugging.  It buffers debug</h5>
<div class="desc"><p>info comprising the input to a Codec encode/decode method, as single UTF-32  encoded characters, as well as the final output from the Codec method.  The  debug info is logged immediately before the Codec method returns its value  and the buffer is cleared at that time.  To enable CodecDebug add the following to the ESAPI.xml file if not already  present:  &lt;SpecialDebugging&gt;&lt;Enabled&gt;true&lt;/Enabled&gt;&lt;/SpecialDebugging&gt;</p><p>PHP version 5.2</p></div>
<ul>
		<li><strong>author:</strong> - jah &lt;<a href="mailto:jah@jahboite.co.uk">jah@jahboite.co.uk</a>&gt;</li>
		<li><strong>version:</strong> - Release: @package_version@</li>
		<li><strong>copyright:</strong> - 2009-2010 The OWASP Foundation</li>
		<li><strong>link:</strong> - <a href="http://www.owasp.org/index.php/ESAPI">http://www.owasp.org/index.php/ESAPI</a></li>
		<li><strong>license:</strong> - <a href="http://www.opensource.org/licenses/bsd-license.php">New BSD license</a></li>
	</ul>
<br /><hr />
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">

<h2 class="tab">Class Variables</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
</div>
<div class="tab-page" id="constantsTabpage">

<h2 class="tab">Class Constants</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "constantsTabpage" ) );</script>
</div>
<div class="tab-page" id="tabPage2">
<h2 class="tab">Method Detail</h2>
<!-- ============ METHOD DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="method-summary">
    <div class="method-definition">
    static         <span class="method-result"><a href="../ESAPI_Codecs/CodecDebug.html">CodecDebug</a></span>
        <a href="#methodgetInstance" title="details" class="method-name">getInstance</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">null</span>
        <a href="#methodaddEncodedString" title="details" class="method-name">addEncodedString</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$stringNormalizedEncoding</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">null</span>
        <a href="#methodaddUnencodedString" title="details" class="method-name">addUnencodedString</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$stringNormalizedEncoding</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">null</span>
        <a href="#methodoutput" title="details" class="method-name">output</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$codecOutput</span>)
        </div>
</div>
<hr />
<A NAME='method_detail'></A>


<a name="methodgetInstance" id="methodgetInstance"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Static Method getInstance</strong> (line <span class="linenumber">90</span>)
 </h4> 
<h4><i><a href="../ESAPI_Codecs/CodecDebug.html">CodecDebug</a></i> <strong>getInstance(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Retrieves the singleton instance of CodecDebug.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - Singleton Instance of CodecDebug.</li>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methodaddEncodedString" id="methodaddEncodedString"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method addEncodedString</strong> (line <span class="linenumber">107</span>)
 </h4> 
<h4><i>null</i> <strong>addEncodedString(
string
$stringNormalizedEncoding)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Adds a string of one or more encoded characters to the debug output.</h5>
<div class="desc"><p>Should be called, for example, from Codec-&gt;decode().</p></div>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $stringNormalizedEncoding</strong>: is a UTF-32 encoded string.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methodaddUnencodedString" id="methodaddUnencodedString"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method addUnencodedString</strong> (line <span class="linenumber">128</span>)
 </h4> 
<h4><i>null</i> <strong>addUnencodedString(
string
$stringNormalizedEncoding)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Adds a string of one or more unencoded characters to the debug output.</h5>
<div class="desc"><p>Should be called, for example, from Codec-&gt;encode().</p></div>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $stringNormalizedEncoding</strong>: is a UTF-32 encoded string.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methodoutput" id="methodoutput"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method output</strong> (line <span class="linenumber">151</span>)
 </h4> 
<h4><i>null</i> <strong>output(
string
$codecOutput)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>output appends the final output from a codec (either an encoded or  decoded string) to the contents of $this-&gt;_buf and then logs this  debugging output before resetting the CodecDebug instance ready for  reuse.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $codecOutput</strong>: is the final output being returned from Codec.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script></div>
<div class="tab-page" id="iVars">
<h2 class="tab">Inherited Variables</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
<!-- =========== VAR INHERITED SUMMARY =========== -->
<A NAME='var_inherited_summary'><!-- --></A>
<h3>Inherited Class Variable Summary</h3>

	</div>
<div class="tab-page" id="iMethods">
<h2 class="tab">Inherited Methods</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h3>Inherited Method Summary</h3>

	</div>
</div>
<script type="text/javascript">
//<![CDATA[

setupAllTabs();

//]]>
</script>
	<div id="credit">
		<hr />
		Documentation generated on Fri, 21 May 2010 10:53:42 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</div>
</body>
</html>